/*
 *  Copyright (C) 2010 Glauco
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Esta anotação é utilizada para construção de editores de entidades.<br>
 * Uma editor possuí um painel para mostrar e editar os valores dos atributos
 * da entidade, e um painel de ações.<br>
 * A busca também pode possuir mapas de ação, que poderão interagir com a
 * entidade que está sendo editada ou vizualizada.<br>
 * <br>
 * Os Valores definidos nesta anotação são utilzados na construção do grid.
 *
 * @see org.balisunrise.annotation.Panel
 * @author Glauco
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Editor {

    /**
     * Representa o nome para construção do editor.
     *
     * @return Retorna o nome para esta definição do editor.
     */
    public String alias() default "";

    /**
     * Título do editor.
     * @return Retorna uma String que representa o título do editor.
     */
    public String title();

    /**
     * Alias do painel do editor.
     * @return Retorna o alias (nome) do painel que será utilizado no editor.
     */
    public String panel();

}
